﻿/*

The MIT License

Copyright (c) 2010 Cartesian Analytics, Inc. 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

*/


using Pipra.Math.Geometry;
using Pipra.Uom;

namespace Pipra.Gis
{
    /// <summary>
    /// Interface for a factory that constructs objects based on a given authority tag.
    /// </summary>
    public interface IAuthorityFactory
    {
        /// <summary>
        /// The authority name for this authority factory.
        /// </summary>
        string AuthorityName { get; }
        /// <summary>
        /// Determines if the given name matches for this authority factory.
        /// </summary>
        /// <param name="name">The name of the authority factory.</param>
        /// <returns>True when matching.</returns>
        bool NameMatches(string name);
        /// <summary>
        /// Creates an authority tag for the given code.
        /// </summary>
        /// <param name="code">The code to create an authority for.</param>
        /// <returns>An authority tag; null on failure.</returns>
        IAuthorityTag CreateAuthorityTag(string code);
        /// <summary>
        /// Creates a spheroid given a <paramref name="code"/>.
        /// </summary>
        /// <param name="code">The code used to create a spheroid from.</param>
        /// <returns>A spheroid or null.</returns>
        ISpheroid<double> CreateSpheroid(string code);
        /// <summary>
        /// Creates a prime meridian given a <paramref name="code"/>.
        /// </summary>
        /// <param name="code">The code used to lookup the entity.</param>
        /// <returns>A prime meridian or null.</returns>
        IPrimeMeridian CreatePrimeMeridian(string code);
        /// <summary>
        /// Creates a unit of measure given a <paramref name="code"/>.
        /// </summary>
        /// <param name="code">The lookup code.</param>
        /// <returns>A UoM or null.</returns>
        IUom CreateUom(string code);

    }
}
